Skip to content

feat: add instructor dashboard SUPPORT_URL legacy fallback to MFE_CONFIG#38446

Merged
brian-smith-tcril merged 1 commit intoopenedx:masterfrom
brian-smith-tcril:instructor-dash-support-url
Apr 27, 2026
Merged

feat: add instructor dashboard SUPPORT_URL legacy fallback to MFE_CONFIG#38446
brian-smith-tcril merged 1 commit intoopenedx:masterfrom
brian-smith-tcril:instructor-dash-support-url

Conversation

@brian-smith-tcril
Copy link
Copy Markdown
Contributor

@brian-smith-tcril brian-smith-tcril commented Apr 24, 2026 •
edited
Loading

Summary

  • Adds a legacy config override layer (get_legacy_config_overrides) so the instructor dashboard gets its SUPPORT_URL from the help-tokens package when no explicit MFE_CONFIG_OVERRIDES entry is set
  • Adds instructor-dashboard to MFE_NAME_TO_APP_ID
  • Refactors get_mfe_config_overrides into separate legacy/explicit/merged helpers

Supports the frontend-base help button (openedx/frontend-base#245). See plan comment for full context.

Test plan

  • Existing tests pass (lms/djangoapps/mfe_config_api/tests/test_views.py)
  • Manual: GET /api/frontend_site_config/v1/ includes an instructor-dashboard app with SUPPORT_URL
  • Manual: GET /api/mfe_config/v1?mfe=instructor-dashboard includes SUPPORT_URL

Expected behavior for instructor-dashboard SUPPORT_URL:

# MFE_CONFIG SUPPORT_URL MFE_CONFIG_OVERRIDES instructor-dashboard SUPPORT_URL help-tokens resolves Expected SUPPORT_URL
1 not set not set https://help.example.com/fallback https://help.example.com/fallback
2 https://help.example.com not set https://help.example.com/fallback https://help.example.com/fallback
3 not set https://help.example.com/instructor https://help.example.com/fallback https://help.example.com/instructor
4 https://help.example.com https://help.example.com/instructor https://help.example.com/fallback https://help.example.com/instructor
5 not set not set fails absent
6 https://help.example.com not set fails https://help.example.com (from common)

🤖 Generated with Claude Code

Settings

GROVE_LMS_ENV: |
  HELP_TOKENS_BOOKS: {}

@brian-smith-tcril brian-smith-tcril changed the title feat: add instructor dashboard SUPPORT_URL legacy fallback to MFE_CONFIG feat: add instructor dashboard SUPPORT_URL legacy fallback to MFE_CONFIG Apr 24, 2026
@brian-smith-tcril brian-smith-tcril force-pushed the instructor-dash-support-url branch 3 times, most recently from 75f6565 to 7e69591 Compare April 24, 2026 16:49
@brian-smith-tcril brian-smith-tcril added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Apr 24, 2026
@brian-smith-tcril
Copy link
Copy Markdown
Contributor Author

brian-smith-tcril commented Apr 27, 2026 •
edited
Loading

Initial sandbox testing:

# MFE_CONFIG SUPPORT_URL MFE_CONFIG_OVERRIDES instructor-dashboard SUPPORT_URL help-tokens resolves Expected SUPPORT_URL
1 not set not set https://docs.openedx.org/en/latest/educators/index.html https://docs.openedx.org/en/latest/educators/index.html
2 https://help.example.com not set https://docs.openedx.org/en/latest/educators/index.html https://docs.openedx.org/en/latest/educators/index.html
3 not set https://help.example.com/instructor https://docs.openedx.org/en/latest/educators/index.html https://help.example.com/instructor
4 https://help.example.com https://help.example.com/instructor https://docs.openedx.org/en/latest/educators/index.html https://help.example.com/instructor

Site config for each test:

1
2 
{
    "MFE_CONFIG": {
        "SUPPORT_URL": "https://help.example.com"
    }
}
3 
{
    "MFE_CONFIG_OVERRIDES": {
        "instructor-dashboard": {
            "SUPPORT_URL": "https://help.example.com/instructor"
        }
    }
}
4 
{
    "MFE_CONFIG": {
        "SUPPORT_URL": "https://help.example.com"
    },
    "MFE_CONFIG_OVERRIDES": {
        "instructor-dashboard": {
            "SUPPORT_URL": "https://help.example.com/instructor"
        }
    }
}
# frontend-site Config instructor dash mfe-config
1 ✅ ✅
2 ✅ ✅
3 ✅ ✅
4 ✅ ✅

@brian-smith-tcril @claude
feat: add instructor dashboard SUPPORT_URL legacy fallback to MFE_CONFIG
40c1faa 
Adds a legacy config override layer so the instructor dashboard gets
its SUPPORT_URL from the help-tokens package when no explicit
MFE_CONFIG_OVERRIDES entry is set. This supports the frontend-base
help button (openedx/frontend-base#245).

Also adds instructor-dashboard to MFE_NAME_TO_APP_ID and refactors
get_mfe_config_overrides into separate legacy/explicit/merged helpers.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@brian-smith-tcril brian-smith-tcril force-pushed the instructor-dash-support-url branch from 7e69591 to 40c1faa Compare April 27, 2026 14:38
@brian-smith-tcril
Copy link
Copy Markdown
Contributor Author

brian-smith-tcril commented Apr 27, 2026

Empty HELP_TOKENS sandbox testing:

# MFE_CONFIG SUPPORT_URL MFE_CONFIG_OVERRIDES instructor-dashboard SUPPORT_URL help-tokens resolves Expected SUPPORT_URL
5 not set not set fails absent
6 https://help.example.com not set fails https://help.example.com (from common)

Site config for each test:

5
6 
{
    "MFE_CONFIG": {
        "SUPPORT_URL": "https://help.example.com"
    }
}
# frontend-site Config instructor dash mfe-config
5 ✅ ✅
6 ✅ ✅

@brian-smith-tcril brian-smith-tcril marked this pull request as ready for review April 27, 2026 17:02
arbrandes
arbrandes approved these changes Apr 27, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me! 👍🏼

@brian-smith-tcril brian-smith-tcril merged commit 7dd54dc into openedx:master Apr 27, 2026
54 of 58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arbrandes arbrandes arbrandes approved these changes

Assignees

No one assigned

Labels

create-sandbox open-craft-grove should create a sandbox environment from this PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@brian-smith-tcril @arbrandes